EventTypes

Kind of class:class
Inherits from:none
Classpath:gfx.events.EventTypes
File last modified:Tuesday, 29 June 2010, 09:03:27
This class defines all the event types as constants to enable developers to add type-safe events to the components. The component framework does not use the constants, as the string equivalents are slightly faster to use, and it has been tested extensively. It is recommended that developers using the component framework use the EventType class to listen for events.

component.addEventListener(EventTypes.CLICK, this, "handleMouseClick");

Summary


Class properties
  • CLICK
    • The mouse has been clicked on a button-type component.
  • DOUBLE_CLICK
    • The mouse has been double-clicked on a button-type component.
  • ROLL_OVER
    • The mouse has been rolled over a button-type component.
  • PRESS
    • The mouse has been pressed on a button-type component.
  • ROLL_OUT
    • The mouse has been rolled out of a button-type component.
  • RELEASE_OUTSIDE
    • The mouse has been depressed outside of a button-type component.
  • ITEM_CLICK
    • The mouse has been clicked on a button-type component inside of a composite component, such as gfx.controls.ScrollingList.
  • ITEM_DOUBLE_CLICK
    • The mouse has been double-clicked on a button-type component inside of a composite component, such as gfx.controls.ScrollingList.
  • ITEM_ROLL_OVER
    • The mouse has been rolled over a button-type component inside of a composite component, such as gfx.controls.ScrollingList.
  • ITEM_PRESS
    • The mouse has been pressed on button-type component inside of a composite component, such as gfx.controls.ScrollingList.
  • ITEM_ROLL_OUT
    • The mouse has been rolled out of a button-type component inside of a composite component, such as gfx.controls.ScrollingList.
  • FOCUS_IN
    • Stage focus has been given to a UIComponent.
  • FOCUS_OUT
    • Stage focus has taken from a UIComponent.
  • SHOW
    • The visible property of a UIComponent has been set from false to true.
  • HIDE
    • The visible property of a UIComponent has been set from true to false.
  • INIT
    • A component has become initialized.
  • CHANGE
    • The value of a component has changed.
  • STATE_CHANGE
    • The frame state of a component has changed.
  • SELECT
    • A Button component's selected property has changed.
  • IO_ERROR
    • A load operation has failed due to an incorrect path name or missing file.
  • PROGRESS
    • A load operation has loaded a percentage of the overall total.
  • COMPLETE
    • A load operation has completed.
  • SCROLL
    • The scroll position of a component has changed.
  • TEXT_CHANGE
    • The text of a component has changed, usually from user input.
  • INPUT
    • The user or game has inputted data, usually through a controller or keyboard.
  • DRAG_BEGIN
    • A component has begun a drag using the gfx.managers.DragManager.
  • DRAG_END
    • A drag operation by the gfx.managers.DragManager has completed.
  • DROP
    • A drag operation has completed, and a component is the target of the drop.

Class properties

CHANGE

static CHANGE:String = "change"
(read,write)

The value of a component has changed. Many components dispatch a "change" event when interacted with, such as changing the gfx.controls.ScrollingList.selectedIndex or a gfx.controls.Slider.value.

CLICK

static CLICK:String = "click"
(read,write)

The mouse has been clicked on a button-type component. Click events are also dispatched when an "enter" navigation equivalent has been input.

COMPLETE

static COMPLETE:String = "complete"
(read,write)

A load operation has completed. Typically used by gfx.controls.ProgressBar and UILoader.

DOUBLE_CLICK

static DOUBLE_CLICK:String = "doubleClick"
(read,write)

The mouse has been double-clicked on a button-type component.

DRAG_BEGIN

static DRAG_BEGIN:String = "dragBegin"
(read,write)

A component has begun a drag using the gfx.managers.DragManager.

DRAG_END

static DRAG_END:String = "dragEnd"
(read,write)

A drag operation by the gfx.managers.DragManager has completed.

DROP

static DROP:String = "drop"
(read,write)

A drag operation has completed, and a component is the target of the drop.

FOCUS_IN

static FOCUS_IN:String = "focusIn"
(read,write)

Stage focus has been given to a UIComponent.

FOCUS_OUT

static FOCUS_OUT:String = "focusOut"
(read,write)

Stage focus has taken from a UIComponent.

HIDE

static HIDE:String = "hide"
(read,write)

The visible property of a UIComponent has been set from true to false.

INIT

static INIT:String = "init"
(read,write)

A component has become initialized. An initialization event is not dispatched from any components by default, but is available to be used when extending or creating components.

INPUT

static INPUT:String = "input"
(read,write)

The user or game has inputted data, usually through a controller or keyboard. gfx.managers.InputDelegate intercepts input from the game and dispatches these events.

IO_ERROR

static IO_ERROR:String = "ioError"
(read,write)

A load operation has failed due to an incorrect path name or missing file. Used by gfx.controls.UILoader.

ITEM_CLICK

static ITEM_CLICK:String = "itemClick"
(read,write)

The mouse has been clicked on a button-type component inside of a composite component, such as gfx.controls.ScrollingList.

ITEM_DOUBLE_CLICK

static ITEM_DOUBLE_CLICK:String = "itemDoubleClick"
(read,write)

The mouse has been double-clicked on a button-type component inside of a composite component, such as gfx.controls.ScrollingList.

ITEM_PRESS

static ITEM_PRESS:String = "itemPress"
(read,write)

The mouse has been pressed on button-type component inside of a composite component, such as gfx.controls.ScrollingList.

ITEM_ROLL_OUT

static ITEM_ROLL_OUT:String = "itemRollOut"
(read,write)

The mouse has been rolled out of a button-type component inside of a composite component, such as gfx.controls.ScrollingList.

ITEM_ROLL_OVER

static ITEM_ROLL_OVER:String = "itemRollOver"
(read,write)

The mouse has been rolled over a button-type component inside of a composite component, such as gfx.controls.ScrollingList.

PRESS

static PRESS:String = "press"
(read,write)

The mouse has been pressed on a button-type component.

PROGRESS

static PROGRESS:String = "progress"
(read,write)

A load operation has loaded a percentage of the overall total. Typically used by gfx.controls.ProgressBar and UILoader.

RELEASE_OUTSIDE

static RELEASE_OUTSIDE:String = "releaseOutside"
(read,write)

The mouse has been depressed outside of a button-type component.

ROLL_OUT

static ROLL_OUT:String = "rollOut"
(read,write)

The mouse has been rolled out of a button-type component.

ROLL_OVER

static ROLL_OVER:String = "rollOver"
(read,write)

The mouse has been rolled over a button-type component.

SCROLL

static SCROLL:String = "scroll"
(read,write)

The scroll position of a component has changed. Used by gfx.controls.ScrollIndicator, as well as list-based components such as gfx.controls.ScrollingList.

SELECT

static SELECT:String = "select"
(read,write)

A Button component's selected property has changed.

SHOW

static SHOW:String = "show"
(read,write)

The visible property of a UIComponent has been set from false to true.

STATE_CHANGE

static STATE_CHANGE:String = "stateChange"
(read,write)

The frame state of a component has changed. Components that use keyframes for states, such as gfx.controls.Button will dispatch a "stateChange" event when interacted with by the user.

TEXT_CHANGE

static TEXT_CHANGE:String = "textChange"
(read,write)

The text of a component has changed, usually from user input. Typically used by gfx.controls.TextInput and gfx.controls.TextArea.